这里写一下最近在Code Review中遇到的一些问题。
遵循良好的日志规范。
- 例如:日志打印logStr act=函数名 msg=信息 入参={} 出参{}
使用Objects.nonNull, Objects.isNull,CollectionUtils来判断对象是否为空,集合是否为空(增强代码可读性)
重复调用二方服务,同一个类中抽取统一的方法或抽取到另外一个Service中。
校验请求是否success,数据是否为Null,再使用数据,否则打印日志
不要轻易修改公用库的DTO,可能会影响其他服务调用方
若A服务和B服务都依赖于C服务,那么因为A服务的时间格式要调整,那么尽量在A服务中修改,不要在C服务中修改,避免影响其他的服务。同时,C服务尽量提供时间戳或Code及枚举类这样的形式便于A服务和B服务定制化结果。
调外部接口,必须使用try catch捕获异常,并正确打印日志
接口要编写接口文档
- 入参及必要的参数说明
- 出参
- 请求示例
- 返回示例
复用已有代码时,要review,确保原先的代码没有问题,避免使用原代码出现问题。